<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
 "http://www.w3.org/TR/html4/frameset.dtd">
<html>
<head>
<title>Madoc &raquo; madoc</title>
<meta name="generator" content="faebusoft Madoc">
<link rel="stylesheet" type="text/css" href="layout.css"></link>
</head>
<body>
<a name="top"></a>
<div class="nav"><a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<h1>Modul madoc</h1>
<p>Das madoc Modul stellt Funktionen zu Verf&uuml;gung zur Erzeugung einer Code Dokumentation im HTML Format. Zudem kann mit diesem Modul pro Modul ein Inhaltsverzeichnis s&auml;mtlicher Funktionen und Prozeduren direkt im Quellcode erstellen. </p><p><h3>Regeln f&uuml;r die Dokumentation</h3> Grunds&auml;tzlich wird der erste Dokumentationsblock <b>vor</b> der ersten Anweisung im Modul als Moduldokumentation interpretiert. Bei Funktionen und Prozeduren wird der Dokumentationsblock unmittelbar vor der Signatur interpretiert. </p><p>S&auml;mtlicher Text kann mittels den HTML Tags &lt; b&gt;...&lt;/ b&gt; als <b>fett</b>, mittels &lt; i&gt;...&lt;/ i&gt; als <i>kursiv</i>, mittels &lt; u&gt;...&lt;/ u&gt; als <u>unterstrichen</u> und mittels &lt; code&gt;...&lt;/ code&gt; als <code>monospaced</code> formatiert werden. </p><p>Um einen neuen Paragraph zu erzeugen, kann eine leere Zeile verwendet werden. Ansonsten werden Zeilen automatisch konkateniert. Um innerhalb eines Paragraphs eine neue Zeile zu erzwingen kann im Text das HTML Tag &lt; br /&gt; eingef&uuml;gt werden (Ohne Leerzeichen am Anfang). </p><p>Zudem k&ouml;nnen mit den Tags &lt; h1&gt;, &lt; h2&gt;, &lt; h3&gt; und &lt; h4&gt; (und den entsprechenden schliessenden Tags) unterschiedliche &Uuml;berschriften eingef&uuml;ht werden. Diese &Uuml;berschriften sollten jedoch nur in der <b>Modulbschreibung</b> verwendet werden. </p><p><h3>Moduledokumentation</h3> Die Moduldokumentation besteht ausschliesslich aus einer Beschreibung. </p><p><h3>Funktions-/Prozedurdokumentation</h3> Die erzeugte Dokumentation wird automatisch aus der Signatur abgeleitet. Zus&auml;tzlich kann eine Kurzbeschreibung, eine ausf&uuml;hrliche Beschreibung und eine Paramter- bzw. R&uuml;ckgabewert Dokumentation verfasst werden.<br /> Dabei beinhaltet die erste Zeile in jedem Fall die Kurzbeschreibung. S&auml;mtliche nachfolgenden Zeilen werden als ausf&uuml;hrlich Beschreibung interpretiert, bis entweder eine Separatorzeile (z.B. <code><font color="green">'***...</font></code> oder <code><font color="green">'---</font></code>) oder ein Tag (z.B. <code>@param</code>) gefunden wird. </p><p><h3>Parameterbeschreibung</h3> Paramter werden mit dem Schl&uuml;sselwort <code>@param</code>, dem Paramternamen und der anschliessenden Dokumentation erfasst. Dabei kann auch hier die Dokumentation mehrzeilig sein. Sie endet ebenfalls bei einer Trennzeile oder bei einem anderen Tag.<br /> Bsp.: <code><font color="green">' @param strText Irgendeintext</font></code> </p><p><h3>R&uuml;ckgabewertbeschreibung</h3> Der R&uuml;ckgabewerte kann mit dem Schl&uuml;sselwort <code>@return</code> dokumentiert werden.<br /> Bsp.: <code><font color="green">' @return Irgendetwas</font></code> </p><p><h3>Verwendung</h3> Mit dem Tag <code>@use</code> kann die Verwendung der Funktion/Prozedur weiter spezifiziert werden.<br /> Bsp.: <code><font color="green">' @use So muss es verwendet werden</font></code> </p><p><h3>Veraltete Funktionen/Prozeduren</h3> Mit dem Schl&uuml;sselwort <code>@deprecated</code> kann eine Funktion oder Prozedur als veraltet gekennzeichnet werden. Hier dem Schl&uuml;sselwort kann ein zus&auml;tzlicher Hinweis notiert werden (z.B. die Ersatzfunktion) Bsp.: <code><font color="green">' @deprecated Neu die Funktion neueFunktion() verwenden</font></code> </p><p><h3>Referenzen</h3> Um auf eine andere Dokumentation zu referenzieren kann das Schl&uuml;sselwort @see verwendet werden. Dahinter kann ein Freitext erfolgen. Es kann aber auch auf eine anderen Funktion/Prozedur referenziert werden, indem diese vollst&auml;ndig mit Modulnamen qualifiziert wird. In diesem Fall wird die Angabe automatisch in einen Link in der Dokumentation umgewandelt.<br /> Bsp.: <code><font color="green">' @see Modul1.meineFunktion</font></code> </p><p><h3>Weiter Angaben</h3> Mit dem Paramter <code>@author</code> kann der Autor der Funktion/Prozedur niedergeschrieben werden. Diese Angabe wird in der Dokumentation jedoch nicht wiedergegeben </p>
<h2><a name="func_summary"></a>Functions Summary</h2>
<table cellspacing="0" cellpadding="4"><colgroup><col width="120px" /><col width="120px" /><col width="*" /></colgroup><thead><tr><td>Scope</td><td>Returntype</td><td>Name and description</td></tr></thead>
<tr><td>Private</td><td><code>Boolean</code></td><td><code><a href="#madoccreatetables">madocCreateTables()</a></code><br />Anlegen Hilfstabellen</td></tr>
<tr><td>Public</td><td><code>Boolean</code></td><td><code><a href="#madoctableexists">madocTableExists()</a></code><br />Pr&uuml;ft, ob Tabelle existiert</td></tr>
<tr><td>Private</td><td><code>Variant</code></td><td><code><a href="#madocparsemodules">madocParseModules()</a></code><br />Parsen der Module</td></tr>
<tr><td>Private</td><td><code>Long</code></td><td><code><a href="#madocgetcodeheaderstart">madocGetCodeHeaderStart()</a></code><br />Ermitteln der Startzeile des Funktionskommentars</td></tr>
<tr><td>Private</td><td><code>String</code></td><td><code><a href="#madocgetcodeheadertitle">madocGetCodeHeaderTitle()</a></code><br />Ermitteln der Kurzbeschreibung einer Funktion/Prozedur</td></tr>
<tr><td>Private</td><td><code>Object</code></td><td><code><a href="#madocgetcodeheaderdescription">madocGetCodeHeaderDescription()</a></code><br />Ermitteln der Detailbeschreibung einer Funktion/Prozedur</td></tr>
<tr><td>Private</td><td><code>Object</code></td><td><code><a href="#madocgetcodeheadertagvalues">madocGetCodeHeaderTagValues()</a></code><br />Ermitteln die Werte zu einem Tag</td></tr>
<tr><td>Private</td><td><code>Object</code></td><td><code><a href="#madocgetcodesignatureparameters">madocGetCodeSignatureParameters()</a></code><br />Ermitteln der Paramter aus der Signatur</td></tr>
<tr><td>Public</td><td><code>String</code></td><td><code><a href="#madocgetcodesignaturereturntype">madocGetCodeSignatureReturnType()</a></code><br />Ermitteln des Return-Typs aus der Signatur</td></tr>
<tr><td>Private</td><td><code>String</code></td><td><code><a href="#madoccreatehtmlfunctionlink">madocCreateHtmlFunctionLink()</a></code><br />Erzeugt einen HTML String f&uuml;r einen Funktionslink</td></tr>
<tr><td>Private</td><td><code>String</code></td><td><code><a href="#madoccreatehtmlnavigation">madocCreateHtmlNavigation()</a></code><br />Erzeugt die HTML Navigation</td></tr>
<tr><td>Private</td><td><code>String</code></td><td><code><a href="#htmlentities">htmlEntities()</a></code><br />Wandelt Sonderzeichen in HTML Entit&auml;ten um</td></tr>
<tr><td>Public</td><td><code>Byte()</code></td><td><code><a href="#base64decode">Base64Decode()</a></code><br />Decodiert einen Base64-String in ein Byte-Array</td></tr>
<tr><td>Private</td><td><code>Byte()</code></td><td><code><a href="#base64convertstringtobytes">Base64ConvertStringToBytes()</a></code><br />Wandelt eine String in einen Byte-Array um</td></tr>
</table>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<h2><a name="subs_summary"></a>Procedures Summary</h2>
<table cellspacing="0" cellpadding="4"><colgroup><col width="120px" /><col width="*" /></colgroup><thead><tr><td>Scope</td><td>Name and description</td></tr></thead>
<tr><td>Public</td><td><code><a href="#madocstart">madocStart()</a></code><br />Started die Erzeugung der Code Dokumentation</td></tr>
<tr><td>Public</td><td><code><a href="#madoccreatehtml">madocCreateHtml()</a></code><br />Erzeugt die HTML Dokumentation</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreatecss">madocCreateCSS()</a></code><br />Erzeugt das Stylesheet</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreateicons">madocCreateIcons()</a></code><br />Erzeugt s&auml;mtliche Bilder</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreatehtmlindex">madocCreateHtmlIndex()</a></code><br />Erzeugt die Index Datei (Frameset)</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreatehtmlmodulesoverview">madocCreateHtmlModulesOverview()</a></code><br />Erzeugt die &Uuml;bersichtsdatei mit s&auml;mtlichen Modulen</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreatehtmlprocoverview">madocCreateHtmlProcOverview()</a></code><br />Erzeugt eine &Uuml;bersicht &uuml;ber s&auml;mtliche Prozeduren/Funktionen</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreatehtmlmoduleprocoverview">madocCreateHtmlModuleProcOverview()</a></code><br />Erzeugt pro Module eine Funktions-/Prozeduren&uuml;bersicht</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreatehtmlmoduleprocdetails">madocCreateHtmlModuleProcDetails()</a></code><br />Erzeugt die Detaildatei f&uuml;r s&auml;mtliche Module</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreatehtmlmoduleprocdetail">madocCreateHtmlModuleProcDetail()</a></code><br />Erzeugt die Detaildatei f&uuml;r ein Module</td></tr>
<tr><td>Private</td><td><code><a href="#madoccreateprocdetailblock">madocCreateProcDetailBlock()</a></code><br />Erzeugt eine HTML Detailsblock</td></tr>
<tr><td>Private</td><td><code><a href="#base64init">Base64Init()</a></code><br />Initialisert die Base64-Umgebung</td></tr>
<tr><td>Private</td><td><code><a href="#madocwritemodulesheader">madocWriteModulesHeader()</a></code><br />Schreibt pro Modul ein Inhaltsverzeichnis direkt am Anfang des Codes</td></tr>
<tr><td>Public</td><td><code><a href="#errorhandle">errorHandle()</a></code></td></tr>
</table>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<h2><a name="func_details"></a>Function Details</h2>
<h3><a name="madoccreatetables"></a>madocCreateTables</h3>
<p><code><pre>private madocCreateTables() AS Boolean</pre></code></p>
<dl>
<dd><p>Legt die ben&ouml;tigten Hilfstabellen f&uuml;r die Erzeugung der Dokumentation an. </p></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoctableexists"></a>madocTableExists</h3>
<p><code><pre>public madocTableExists(ByRef strTable AS String) AS Boolean</pre></code></p>
<dl>
<dd><p>Pr&uuml;ft, ob eine Tabelle bereits existiert </p></dd>
<dd><dl><dt>Parameter:</dt><dd><code>strTable</code> - Name der Tabelle</dd></dl><dl><dt>Returns:</dt><dd><code>true</code>, wenn Tabelle existiert</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madocparsemodules"></a>madocParseModules</h3>
<p><code><pre>private madocParseModules() AS Variant</pre></code></p>
<dl>
<dd><p>Interpretiert s&auml;mtliche Module, liest die Modulbeschreibung, ermittelt s&auml;mtliche Funktionen und Prozeduren und liest die entsprechende Dokumentation dazu inkl. den mit Schl&uuml;sselw&ouml;rtern definierten Angaben </p></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madocgetcodeheaderstart"></a>madocGetCodeHeaderStart</h3>
<p><code><pre>private madocGetCodeHeaderStart(ByRef arrLines AS Variant<br />                                ByRef lngStart) AS Long</pre></code></p>
<dl>
<dd><p>Ermittelt die Startposition der Beschreibung einer Funktion oder Prozedur </p></dd>
<dd><dl><dt>Parameter:</dt><dd><code>arrLines</code> - Array mit dem vollst&auml;ndigen Code</dd><dd><code>lngStart</code> - Startposition der Funktion/Prozedur</dd></dl><dl><dt>Returns:</dt><dd>Startzeile des Kommentars oder -1, wenn kein Kommentar</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madocgetcodeheadertitle"></a>madocGetCodeHeaderTitle</h3>
<p><code><pre>private madocGetCodeHeaderTitle(ByRef arrLines AS Variant<br />                                ByRef lngStart AS Long) AS String</pre></code></p>
<dl>
<dd><p>Gibt die Kurzbeschreibung einer Funktion/Prozedur zur&uuml;ck. Die Kurzbeschreibung muss sich in der <b>ersten</b> Zeile des Kommentars </p></dd>
<dd><dl><dt>Parameter:</dt><dd><code>arrLines</code> - Array mit dem vollst&auml;ndigen Code</dd><dd><code>lngStart</code> - Startposition des Kommentars</dd></dl><dl><dt>Returns:</dt><dd>Kurztext</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madocgetcodeheaderdescription"></a>madocGetCodeHeaderDescription</h3>
<p><code><pre>private madocGetCodeHeaderDescription(ByRef arrLines AS Variant<br />                                      ByRef lngStart AS Long) AS Object</pre></code></p>
<dl>
<dd><p>Gibt die Detailsbeschreibung einer Funktion/Prozedur zur&uuml;ck. Die Kurzbeschreibung muss sich ab der <b>zweiten</b> Zeile des Kommentars </p></dd>
<dd><dl><dt>Parameter:</dt><dd><code>arrLines</code> - Array mit dem vollst&auml;ndigen Code</dd><dd><code>lngStart</code> - Startposition des Kommentars</dd></dl><dl><dt>Returns:</dt><dd>Eine Collection mit der Zeile als Key</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madocgetcodeheadertagvalues"></a>madocGetCodeHeaderTagValues</h3>
<p><code><pre>private madocGetCodeHeaderTagValues(ByRef arrLines AS Variant<br />                                    ByRef lngStart AS Long<br />                                    ByRef strPattern AS String<br />                                    Optional ByRef bolFirstValAsKey AS Boolean = False) AS Object</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>arrLines</code> - Array mit dem vollst&auml;ndigen Code</dd><dd><code>lngStart</code> - Startposition des Kommentars</dd><dd><code>strPattern</code> - Zu suchendes Tag (mit @), Konstanten MADOC_TAG_*</dd><dd><code>bolFirstValAsKey</code> - Wenn <code>true</code>, dann wird der Wert durch einen Whitespace oder Tab getrennt und der erst Wert wird als Key in die Collection &uuml;bernommen</dd></dl><dl><dt>Returns:</dt><dd>Eine Collection, mit Zeile als Key oder mit ersten Token als Key (Siehe Paramter <code>bolFirstValAsKey</code></dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madocgetcodesignatureparameters"></a>madocGetCodeSignatureParameters</h3>
<p><code><pre>private madocGetCodeSignatureParameters(ByRef arrLines AS Variant<br />                                        ByRef lngStart AS Long) AS Object</pre></code></p>
<dl>
<dd><p>Ermittelt s&auml;mtliche Parameter aus der <b>Signatur</b> der Defintion </p></dd>
<dd><dl><dt>Parameter:</dt><dd><code>arrLines</code> - Array mit dem vollst&auml;ndigen Code</dd><dd><code>lngStart</code> - Startposition des Kommentars</dd></dl><dl><dt>Returns:</dt><dd>Eine Collection, mit einem Counter als Key</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madocgetcodesignaturereturntype"></a>madocGetCodeSignatureReturnType</h3>
<p><code><pre>public madocGetCodeSignatureReturnType(ByRef arrLines AS Variant<br />                                       ByRef lngStart AS Long) AS String</pre></code></p>
<dl>
<dd><p>Ermitteln den R&uuml;ckgabewert-Typ aus der Signatur </p></dd>
<dd><dl><dt>Parameter:</dt><dd><code>arrLines</code> - Array mit dem vollst&auml;ndigen Code</dd><dd><code>lngStart</code> - Startposition des Kommentars</dd></dl><dl><dt>Returns:</dt><dd>R&uuml;ckgabewert-Typ oder leer, wenn nicht definiert</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtmlfunctionlink"></a>madocCreateHtmlFunctionLink</h3>
<p><code><pre>private madocCreateHtmlFunctionLink(ByRef rstFunctions AS DAO.Recordset) AS String</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>rstFunctions</code></dd></dl><dl><dt>Returns:</dt><dd>HTML String</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtmlnavigation"></a>madocCreateHtmlNavigation</h3>
<p><code><pre>private madocCreateHtmlNavigation(Optional ByRef bolSmall AS Boolean = False<br />                                  Optional ByRef bolFunctions AS Boolean = True<br />                                  Optional ByRef bolSubs AS Boolean = True) AS String</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>bolSmall</code> - Wenn <code>True</code>, wird eine kleine Navigation ausgegeben</dd><dd><code>bolFunctions</code> - Wenn <code>True</code>, werden die entsprechenden Links f&uuml;r Funktionsbl&ouml;cke erzeugt</dd><dd><code>bolSubs</code> - Wenn <code>True</code>, werden die entsprechenden Links f&uuml;r Prozedurbl&ouml;cke erzeugt</dd></dl><dl><dt>Returns:</dt><dd>HTML String</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="htmlentities"></a>htmlEntities</h3>
<p><code><pre>private htmlEntities(ByRef strInput) AS String</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strInput</code> - Eingabe</dd></dl><dl><dt>Returns:</dt><dd>Umgewandelter String</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="base64decode"></a>Base64Decode</h3>
<p><code><pre>public Base64Decode(ByVal s AS String) AS Byte()</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>s</code> - Eingabe-String</dd></dl><dl><dt>Returns:</dt><dd>Byte-Array</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="base64convertstringtobytes"></a>Base64ConvertStringToBytes</h3>
<p><code><pre>private Base64ConvertStringToBytes(ByVal s AS String) AS Byte()</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>s</code> - Eingabe-String</dd></dl><dl><dt>Returns:</dt><dd>Byte-Array</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h2><a name="sub_details"></a>Procedures Details</h2>
<h3><a name="madocstart"></a>madocStart</h3>
<p><code><pre>public madocStart(Optional ByRef strFolder AS String<br />                  Optional ByRef bolOpenDoc AS Boolean = True<br />                  Optional ByRef bolWriteHeader AS Boolean = False)</pre></code></p>
<dl>
<dd><p>Erzeugt automatisch eine vollst&auml;ndige Dokumentation des Codes und f&uuml;gt optional ein Inhaltsverzeichnis mit s&auml;mtlichen Funktionen/Prozeruden am Anfang des Codes ein </p></dd>
<dd><dl><dt>Parameter:</dt><dd><code>strFolder</code> - Ausgabeverzeichnis</dd><dd><code>bolOpenDoc</code> - Dokumentation im Anschluss &ouml;ffnen?</dd><dd><code>bolWriteHeader</code> - Schreiben des Inhaltsverzeichnisses</dd></dl><dl><dt>See also:</dt><dd> Siehe auch printing.druckenMarschbefehleDienstabrechnungen</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtml"></a>madocCreateHtml</h3>
<p><code><pre>public madocCreateHtml(Optional ByRef strFolder AS String<br />                       Optional ByRef bolOpenDoc AS Boolean = True)</pre></code></p>
<dl>
<dd><p>Erzeugt s&auml;mtliche HTML Dateien, sowie die CSS Datei und die ben&ouml;tigten Bilder. </p></dd>
<dd><dl><dt>Parameter:</dt><dd><code>strFolder</code> - Ausgabeverzeichnis</dd><dd><code>bolOpenDoc</code> - Dokumentation &Ouml;ffnen nach der Erstellung</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatecss"></a>madocCreateCSS</h3>
<p><code><pre>private madocCreateCSS(ByRef strPath AS String)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strPath</code> - Ausgabepfad</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreateicons"></a>madocCreateIcons</h3>
<p><code><pre>private madocCreateIcons(ByRef strPath AS String)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strPath</code> - Ausgabepfad</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtmlindex"></a>madocCreateHtmlIndex</h3>
<p><code><pre>private madocCreateHtmlIndex(ByRef strPath AS String)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strPath</code> - Ausgabepfad</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtmlmodulesoverview"></a>madocCreateHtmlModulesOverview</h3>
<p><code><pre>private madocCreateHtmlModulesOverview(ByRef strPath AS String)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strPath</code> - Ausgabepfad</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtmlprocoverview"></a>madocCreateHtmlProcOverview</h3>
<p><code><pre>private madocCreateHtmlProcOverview(ByRef strPath AS String)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strPath</code> - Ausgabepfad</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtmlmoduleprocoverview"></a>madocCreateHtmlModuleProcOverview</h3>
<p><code><pre>private madocCreateHtmlModuleProcOverview(ByRef strPath AS String)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strPath</code> - Ausgabepfad</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtmlmoduleprocdetails"></a>madocCreateHtmlModuleProcDetails</h3>
<p><code><pre>private madocCreateHtmlModuleProcDetails(ByRef strPath AS String)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strPath</code> - Ausgabepfad</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreatehtmlmoduleprocdetail"></a>madocCreateHtmlModuleProcDetail</h3>
<p><code><pre>private madocCreateHtmlModuleProcDetail(ByRef strPath AS String<br />                                        ByRef strModule AS String)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>strPath</code> - Ausgabepfad</dd><dd><code>strModule</code> - Name des Moduls</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madoccreateprocdetailblock"></a>madocCreateProcDetailBlock</h3>
<p><code><pre>private madocCreateProcDetailBlock(ByRef Out AS Object<br />                                   ByRef rst AS DAO.Recordset)</pre></code></p>
<dl>
<dd><dl><dt>Parameter:</dt><dd><code>Out</code> - Filesystem-Objekt f&uuml;r die Ausgabe</dd><dd><code>rst</code> - Recordset-Objekt der Funktions-/Prozedurdefinition</dd></dl></dd>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="base64init"></a>Base64Init</h3>
<p><code><pre>private Base64Init()</pre></code></p>
<dl>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="madocwritemodulesheader"></a>madocWriteModulesHeader</h3>
<p><code><pre>private madocWriteModulesHeader()</pre></code></p>
<dl>
</dl>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<h3><a name="errorhandle"></a>errorHandle</h3>
<p><code><pre>public errorHandle()</pre></code></p>
<div class="navsmall"><a href="#top" class="navtop">On top</a> | <a href="#func_summary">Functions Summary</a> | <a href="#subs_summary">Procedures Summary</a> | <a href="#func_details">Functions Details</a> | <a href="#sub_details">Procedures Details</a></div>
<hr />
<i>
<p>Generated on 2010-09-15 08:32:58 by <a href="#">Madoc</a><br />
For more information please visit <a href="http://www.faebusoft.ch">faebusoft.ch</a>
</i>
</body>
</html>
